FHIR Server FHIR Server Version n/a

Resource CapabilityStatement/FHIR Server from package hl7.fhir.uv.cql#current (31 ms)

Package

hl7.fhir.uv.cql

Type

CapabilityStatement

FHIR Version

Source

http://hl7.org/fhir/uv/cql/https://build.fhir.org/ig/HL7/cql-ig/CapabilityStatement-cql-evaluation-service.html

Url

http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service

Version

2.0.0-ballot

Status

draft

Date

2024-12-16T19:25:00+00:00

Name

CQLEvaluationService

Title

CQL Evaluation Service

Experimental

False

Realm

Authority

hl7

Description

Capability statement for a service supporting CQL evaluation use cases

Kind

requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide

hl7.fhir.uv.cql

Using CQL with FHIR

http://hl7.org/fhir/uv/cql/OperationDefinition/cql-cql

CQL CQL

http://hl7.org/fhir/uv/cql/OperationDefinition/cql-library-evaluate

CQL Library Evaluate

http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library

CQL Library

http://hl7.org/fhir/uv/cql/StructureDefinition/cql-modelinfo

CQL Model Info

http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module

CQL Module

http://hl7.org/fhir/uv/cql/StructureDefinition/elm-json-library

ELM JSON Library

http://hl7.org/fhir/uv/cql/StructureDefinition/elm-xml-library

ELM XML Library

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement cql-evaluation-service

CQL Evaluation Service

Implementation Guide Version: 2.0.0-ballot
FHIR Version: 4.0.1
Supported Formats: json, xml
Supported Patch Formats:
Published on: 2024-12-16 19:25:00+0000
Published by: HL7 International / Clinical Decision Support

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

http://hl7.org/fhir/uv/cql/ImplementationGuide/hl7.fhir.uv.cql

FHIR RESTful Capabilities

Mode: `server`

RESTful CQL Evaluation Service

Security

Enable CORS: yes

Security services supported: Certificates

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	S	U	C	Searches	`_include`	`_revinclude`	Operations
Library	http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library Additional supported profiles: CQL Model Info CQL Module ELM XML Library ELM JSON Library	y	y			date, name, title, identifier, description, status, url, version, composed-of, depends-on

Resource Conformance: SHALL Library

Base System Profile
CQL Library

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CQL Model Info
CQL Module
ELM XML Library
ELM JSON Library

Interaction summary

SHALL support
read
Read allows clients to get the logical definitions of the available libraries

search-type
Search allows clients to find libraries on the server

Search Parameters

Conformance	Parameter	Type
SHALL	date	`date`
SHALL	name	`string`
SHALL	title	`string`
SHALL	identifier	`token`
SHALL	description	`string`
SHALL	status	`token`
SHALL	url	`uri`
SHALL	version	`token`
SHALL	composed-of	`reference`
SHALL	depends-on	`reference`

Operations

Use

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "cql-evaluation-service",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement cql-evaluation-service</b></p><a name=\"cql-evaluation-service\"> </a><a name=\"hccql-evaluation-service\"> </a><a name=\"cql-evaluation-service-en-US\"> </a><h2 id=\"title\">CQL Evaluation Service</h2><ul><li>Implementation Guide Version: 2.0.0-ballot </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-12-16 19:25:00+0000 </li><li>Published by: HL7 International / Clinical Decision Support </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li><a href=\"index.html\">http://hl7.org/fhir/uv/cql/ImplementationGuide/hl7.fhir.uv.cql</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>RESTful CQL Evaluation Service</p>\n</div><div class=\"lead\"><em>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: yes</div><div class=\"col-lg-6\">Security services supported: <code>Certificates</code></div></div><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Library1-1\">Library</a></td><td><a href=\"StructureDefinition-cql-library.html\">http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library</a><br/><em>Additional supported profiles:</em><br/>ï¿½ï¿½<a href=\"StructureDefinition-cql-modelinfo.html\">CQL Model Info</a><br/>ï¿½ï¿½<a href=\"StructureDefinition-cql-module.html\">CQL Module</a><br/>ï¿½ï¿½<a href=\"StructureDefinition-elm-xml-library.html\">ELM XML Library</a><br/>ï¿½ï¿½<a href=\"StructureDefinition-elm-json-library.html\">ELM JSON Library</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>date, name, title, identifier, description, status, url, version, composed-of, depends-on</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Library1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Library</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-cql-library.html\">CQL Library</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-cql-modelinfo.html\">CQL Model Info</a><br/><a href=\"StructureDefinition-cql-module.html\">CQL Module</a><br/><a href=\"StructureDefinition-elm-xml-library.html\">ELM XML Library</a><br/><a href=\"StructureDefinition-elm-json-library.html\">ELM JSON Library</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Read allows clients to get the logical definitions of the available libraries</p>\n</div><code>search-type</code><div><p>Search allows clients to find libraries on the server</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">date</a></td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">name</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">title</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">description</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">status</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">version</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">composed-of</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">depends-on</a></td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">ï¿½</div></div></div></div></div><h3 id=\"operationsCap1\">Operations</h3><h4 id=\"operationsSummary1\">Use</h4></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service",
  "version" : "2.0.0-ballot",
  "name" : "CQLEvaluationService",
  "title" : "CQL Evaluation Service",
  "status" : "draft",
  "experimental" : false,
  "date" : "2024-12-16T19:25:00+00:00",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "Capability statement for a service supporting CQL evaluation use cases",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "json",
    "xml"
  ],
  "implementationGuide" : [
    "http://hl7.org/fhir/uv/cql/ImplementationGuide/hl7.fhir.uv.cql"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "RESTful CQL Evaluation Service",
      "security" : {
        "cors" : true,
        "service" : [
          {
            "coding" : [
              {
                "system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code" : "Certificates"
              }
            ]
          }
        ]
      },
      "resource" : [
        {
          "type" : "Library",
          "profile" : "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library",
          "supportedProfile" : [
            "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-modelinfo",
            "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module",
            "http://hl7.org/fhir/uv/cql/StructureDefinition/elm-xml-library",
            "http://hl7.org/fhir/uv/cql/StructureDefinition/elm-json-library"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Read allows clients to get the logical definitions of the available libraries"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type",
              "documentation" : "Search allows clients to find libraries on the server"
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "date",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-date",
              "type" : "date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "title",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-title",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-identifier",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "description",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-description",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-status",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "url",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-url",
              "type" : "uri"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "version",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-version",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "composed-of",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-composed-of",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "depends-on",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-composed-of",
              "type" : "reference"
            }
          ]
        }
      ],
      "operation" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "name" : "cql",
          "definition" : "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-cql"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "name" : "evaluate",
          "definition" : "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-library-evaluate"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.

Resource CapabilityStatement/FHIR Server from package hl7.fhir.uv.cql#current (31 ms)

Resources that use this resource

Resources that this resource uses

Narrative

CQL Evaluation Service

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL Library

Operations

Use

Source

Mode: `server`